blob: e70216dfe6c2deb35f5f90e2ca4d5b674ffb719a [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-separated segment and the section name is everything before the last
Junio C Hamano81d540a2012-03-02 19:52:4715dot. The variable names are case-insensitive, allow only alphanumeric
16characters and `-`, and must start with an alphabetic character. Some
17variables may appear multiple times.
Junio C Hamano07824ce2006-04-25 07:36:5418
Junio C Hamanobee172f2007-01-23 08:44:1819Syntax
20~~~~~~
21
Junio C Hamano07824ce2006-04-25 07:36:5422The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1823ignored. The '#' and ';' characters begin comments to the end of line,
24blank lines are ignored.
25
26The file consists of sections and variables. A section begins with
27the name of the section in square brackets and continues until the next
28section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4829characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanof4581102009-04-25 08:29:5930must belong to some section, which means that there must be a section
31header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1832
33Sections can be further divided into subsections. To begin a subsection
34put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5935in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1836
37--------
38[section "subsection"]
39
40--------
41
Junio C Hamanof4581102009-04-25 08:29:5942Subsection names are case sensitive and can contain any characters except
43newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44respectively). Section headers cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1845lines. Variables may belong directly to a section or to a given subsection.
46You can have `[section]` if you have `[section "subsection"]`, but you
47don't need to.
48
Junio C Hamano6231f822011-10-24 05:18:5249There is also a deprecated `[section.subsection]` syntax. With this
50syntax, the subsection name is converted to lower-case and is also
51compared case sensitively. These subsection names follow the same
52restrictions as section names.
Junio C Hamanobee172f2007-01-23 08:44:1853
Junio C Hamanoaa2cd762009-07-26 08:14:0154All the other lines (and the remainder of the line after the section
55header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1856'name = value'. If there is no equal sign on the line, the entire line
57is taken as 'name' and the variable is recognized as boolean "true".
Junio C Hamano81d540a2012-03-02 19:52:4758The variable names are case-insensitive, allow only alphanumeric characters
59and `-`, and must start with an alphabetic character. There can be more
60than one value for a given variable; we say then that the variable is
61multivalued.
Junio C Hamanobee172f2007-01-23 08:44:1862
63Leading and trailing whitespace in a variable value is discarded.
64Internal whitespace within a variable value is retained verbatim.
65
66The values following the equals sign in variable assign are all either
67a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano059bca52011-03-30 22:47:46681/0, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1869converting value to the canonical form using '--bool' type specifier;
Junio C Hamano1aa40d22010-01-21 17:46:4370'git config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1871
72String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5973You need to enclose variable values in double quotes if you want to
74preserve leading or trailing whitespace, or if the variable value contains
75comment characters (i.e. it contains '#' or ';').
76Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4877be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1878
Junio C Hamanoea82cff2009-03-18 01:54:4879The following escape sequences (beside `\"` and `\\`) are recognized:
80`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1882char sequences are valid.
83
Junio C Hamanof4581102009-04-25 08:29:5984Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1885customary UNIX fashion.
86
Junio C Hamanof4581102009-04-25 08:29:5987Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5488
Junio C Hamanoe0238c22012-02-23 22:45:5089Includes
90~~~~~~~~
91
92You can include one config file from another by setting the special
93`include.path` variable to the name of the file to be included. The
94included file is expanded immediately, as if its contents had been
95found at the location of the include directive. If the value of the
96`include.path` variable is a relative path, the path is considered to be
97relative to the configuration file in which the include directive was
Junio C Hamano22700fb2012-05-03 23:07:2598found. The value of `include.path` is subject to tilde expansion: `~/`
99is expanded to the value of `$HOME`, and `~user/` to the specified
Junio C Hamano4d61c4a2012-04-30 01:10:22100user's home directory. See below for examples.
Junio C Hamanoe0238c22012-02-23 22:45:50101
Junio C Hamano07824ce2006-04-25 07:36:54102Example
103~~~~~~~
104
105# Core variables
106[core]
107; Don't trust file modes
108filemode = false
109
110# Our diff algorithm
111[diff]
Junio C Hamano85c71572008-07-28 00:03:31112external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:54113renames = true
114
Junio C Hamano52401ef2006-12-19 00:54:38115[branch "devel"]
116remote = origin
117merge = refs/heads/devel
118
Junio C Hamanobee172f2007-01-23 08:44:18119# Proxy settings
120[core]
Junio C Hamanoc71a8732007-08-04 00:27:26121gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18122gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38123
Junio C Hamanoe0238c22012-02-23 22:45:50124[include]
125path = /path/to/foo.inc ; include by absolute path
126path = foo ; expand "foo" relative to the current file
Junio C Hamano4d61c4a2012-04-30 01:10:22127path = ~/foo ; expand "foo" in your $HOME directory
Junio C Hamanoe0238c22012-02-23 22:45:50128
Junio C Hamano07824ce2006-04-25 07:36:54129Variables
130~~~~~~~~~
131
132Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17133For command-specific variables, you will find a more detailed description
134in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54135porcelain configuration variables in the respective porcelain documentation.
136
Junio C Hamano7df6dcf2009-09-13 09:51:17137advice.*::
Junio C Hamano0df92712011-12-21 22:30:44138These variables control various optional help messages designed to
139aid new users. All 'advice.*' variables default to 'true', and you
140can tell Git that you do not need help by setting these to 'false':
Junio C Hamano7df6dcf2009-09-13 09:51:17141+
142--
143pushNonFastForward::
Junio C Hamano0c1b64e2012-04-20 23:50:49144Set this variable to 'false' if you want to disable
145'pushNonFFCurrent', 'pushNonFFDefault', and
146'pushNonFFMatching' simultaneously.
147pushNonFFCurrent::
148Advice shown when linkgit:git-push[1] fails due to a
149non-fast-forward update to the current branch.
150pushNonFFDefault::
151Advice to set 'push.default' to 'upstream' or 'current'
152when you ran linkgit:git-push[1] and pushed 'matching
153refs' by default (i.e. you did not provide an explicit
154refspec, and no 'push.default' configuration was set)
155and it resulted in a non-fast-forward error.
156pushNonFFMatching::
157Advice shown when you ran linkgit:git-push[1] and pushed
158'matching refs' explicitly (i.e. you used ':', or
159specified a refspec that isn't your current branch) and
160it resulted in a non-fast-forward error.
Junio C Hamano7df6dcf2009-09-13 09:51:17161statusHints::
Junio C Hamano644936c2012-06-28 23:05:14162Show directions on how to proceed from the current
163state in the output of linkgit:git-status[1] and in
164the template shown when writing commit messages in
165linkgit:git-commit[1].
Junio C Hamano5706e0b2009-11-24 10:54:16166commitBeforeMerge::
167Advice shown when linkgit:git-merge[1] refuses to
Junio C Hamano619596a2010-08-18 22:15:35168merge to avoid overwriting local changes.
Junio C Hamanoa9701f02010-01-21 00:42:16169resolveConflict::
170Advices shown by various commands when conflicts
171prevent the operation from being performed.
Junio C Hamanoa9701f02010-01-21 00:42:16172implicitIdentity::
173Advice on how to set your identity configuration when
174your information is guessed from the system username and
Junio C Hamano0df92712011-12-21 22:30:44175domain name.
Junio C Hamano74a198f2010-02-22 00:13:31176detachedHead::
Junio C Hamano0df92712011-12-21 22:30:44177Advice shown when you used linkgit:git-checkout[1] to
Junio C Hamano74a198f2010-02-22 00:13:31178move to the detach HEAD state, to instruct how to create
Junio C Hamano0df92712011-12-21 22:30:44179a local branch after the fact.
Junio C Hamanobb300642012-07-22 21:09:14180amWorkDir::
181Advice that shows the location of the patch file when
182linkgit:git-am[1] fails to apply it.
Junio C Hamano7df6dcf2009-09-13 09:51:17183--
184
Junio C Hamano07824ce2006-04-25 07:36:54185core.fileMode::
186If false, the executable bit differences between the index and
Junio C Hamano8fb66e52011-10-05 20:59:51187the working tree are ignored; useful on broken filesystems like FAT.
Junio C Hamano9df0c662009-11-23 11:09:27188See linkgit:git-update-index[1].
189+
190The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
191will probe and set core.fileMode false if appropriate when the
192repository is created.
Junio C Hamano07824ce2006-04-25 07:36:54193
Junio C Hamanoa476efa2008-10-10 15:31:42194core.ignoreCygwinFSTricks::
195This option is only used by Cygwin implementation of Git. If false,
196the Cygwin stat() and lstat() functions are used. This may be useful
197if your repository consists of a few separate directories joined in
198one hierarchy using Cygwin mount. If true, Git uses native Win32 API
199whenever it is possible and falls back to Cygwin functions only to
200handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33201normal Cygwin l/stat() functions. True by default, unless core.filemode
202is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
203POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42204
Junio C Hamano9df0c662009-11-23 11:09:27205core.ignorecase::
206If true, this option enables various workarounds to enable
207git to work better on filesystems that are not case sensitive,
208like FAT. For example, if a directory listing finds
209"makefile" when git expects "Makefile", git will assume
210it is really the same file, and continue to remember it as
211"Makefile".
212+
213The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
214will probe and set core.ignorecase true if appropriate when the repository
215is created.
216
Junio C Hamanob61a7772012-07-13 23:34:48217core.precomposeunicode::
218This option is only used by Mac OS implementation of git.
219When core.precomposeunicode=true, git reverts the unicode decomposition
220of filenames done by Mac OS. This is useful when sharing a repository
221between Mac OS and Linux or Windows.
222(Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7).
223When false, file names are handled fully transparent by git,
224which is backward compatible with older versions of git.
225
Junio C Hamano90ccff32008-07-29 08:17:24226core.trustctime::
227If false, the ctime differences between the index and the
Junio C Hamano8fb66e52011-10-05 20:59:51228working tree are ignored; useful when the inode change time
Junio C Hamano90ccff32008-07-29 08:17:24229is regularly modified by something outside Git (file system
230crawlers and some backup systems).
231See linkgit:git-update-index[1]. True by default.
232
Junio C Hamanod526ba92007-07-02 00:17:42233core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31234The commands that output paths (e.g. 'ls-files',
235'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42236"unusual" characters in the pathname by enclosing the
237pathname in a double-quote pair and with backslashes the
238same way strings in C source code are quoted. If this
239variable is set to false, the bytes higher than 0x80 are
240not quoted but output as verbatim. Note that double
241quote, backslash and control characters are always
242quoted without `-z` regardless of the setting of this
243variable.
244
Junio C Hamanobb88cf42010-06-21 15:23:55245core.eol::
246Sets the line ending type to use in the working directory for
247files that have the `text` property set. Alternatives are
248'lf', 'crlf' and 'native', which uses the platform's native
249line ending. The default value is `native`. See
250linkgit:gitattributes[5] for more information on end-of-line
251conversion.
Junio C Hamanod9e0e5d2007-04-14 16:22:04252
Junio C Hamano26e590a2008-02-17 03:53:51253core.safecrlf::
Junio C Hamanobb88cf42010-06-21 15:23:55254If true, makes git check if converting `CRLF` is reversible when
255end-of-line conversion is active. Git will verify if a command
Junio C Hamano26e590a2008-02-17 03:53:51256modifies a file in the work tree either directly or indirectly.
257For example, committing a file followed by checking out the
258same file should yield the original file in the work tree. If
259this is not the case for the current setting of
260`core.autocrlf`, git will reject the file. The variable can
261be set to "warn", in which case git will only warn about an
262irreversible conversion but continue the operation.
263+
264CRLF conversion bears a slight chance of corrupting data.
Junio C Hamanobb88cf42010-06-21 15:23:55265When it is enabled, git will convert CRLF to LF during commit and LF to
Junio C Hamano26e590a2008-02-17 03:53:51266CRLF during checkout. A file that contains a mixture of LF and
267CRLF before the commit cannot be recreated by git. For text
268files this is the right thing to do: it corrects line endings
269such that we have only LF line endings in the repository.
270But for binary files that are accidentally classified as text the
271conversion can corrupt data.
272+
273If you recognize such corruption early you can easily fix it by
274setting the conversion type explicitly in .gitattributes. Right
275after committing you still have the original file in your work
276tree and this file is not yet corrupted. You can explicitly tell
277git that this file is binary and git will handle the file
278appropriately.
279+
280Unfortunately, the desired effect of cleaning up text files with
281mixed line endings and the undesired effect of corrupting binary
282files cannot be distinguished. In both cases CRLFs are removed
283in an irreversible way. For text files this is the right thing
284to do because CRLFs are line endings, while for binary files
285converting CRLFs corrupts data.
286+
287Note, this safety check does not mean that a checkout will generate a
288file identical to the original file for a different setting of
Junio C Hamanobb88cf42010-06-21 15:23:55289`core.eol` and `core.autocrlf`, but only for the current one. For
290example, a text file with `LF` would be accepted with `core.eol=lf`
291and could later be checked out with `core.eol=crlf`, in which case the
Junio C Hamano26e590a2008-02-17 03:53:51292resulting file would contain `CRLF`, although the original file
293contained `LF`. However, in both work trees the line endings would be
294consistent, that is either all `LF` or all `CRLF`, but never mixed. A
295file with mixed line endings would be reported by the `core.safecrlf`
296mechanism.
297
Junio C Hamanobb88cf42010-06-21 15:23:55298core.autocrlf::
299Setting this variable to "true" is almost the same as setting
300the `text` attribute to "auto" on all files except that text
301files are not guaranteed to be normalized: files that contain
302`CRLF` in the repository will not be touched. Use this
303setting if you want to have `CRLF` line endings in your
304working directory even though the repository does not have
305normalized line endings. This variable can be set to 'input',
306in which case no output conversion is performed.
307
Junio C Hamanoaa83a7d2007-03-05 02:37:29308core.symlinks::
309If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46310contain the link text. linkgit:git-update-index[1] and
311linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29312file. Useful on filesystems like FAT that do not support
Junio C Hamano9df0c662009-11-23 11:09:27313symbolic links.
314+
315The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
316will probe and set core.symlinks false if appropriate when the repository
317is created.
Junio C Hamanoaa83a7d2007-03-05 02:37:29318
Junio C Hamano07824ce2006-04-25 07:36:54319core.gitProxy::
320A "proxy command" to execute (as 'command host port') instead
321of establishing direct connection to the remote server when
322using the git protocol for fetching. If the variable value is
323in the "COMMAND for DOMAIN" format, the command is applied only
324on hostnames ending with the specified domain string. This variable
325may be set multiple times and is matched in the given order;
326the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17327+
328Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
329(which always applies universally, without the special "for"
330handling).
Junio C Hamanoea82cff2009-03-18 01:54:48331+
332The special string `none` can be used as the proxy command to
333specify that no proxy be used for a given domain pattern.
334This is useful for excluding servers inside a firewall from
335proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54336
337core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34338If true, commands which modify both the working tree and the index
339will mark the updated paths with the "assume unchanged" bit in the
340index. These marked files are then assumed to stay unchanged in the
Junio C Hamano8fb66e52011-10-05 20:59:51341working tree, until you mark them otherwise manually - Git will not
Junio C Hamano054ea082008-06-01 08:26:34342detect the file changes by lstat() calls. This is useful on systems
343where those are very slow, such as Microsoft Windows.
344See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54345False by default.
346
Junio C Hamano88a3a072006-05-04 08:01:43347core.preferSymlinkRefs::
348Instead of the default "symref" format for HEAD
349and other symbolic reference files, use symbolic links.
350This is sometimes needed to work with old scripts that
351expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54352
Junio C Hamano1025e752007-02-23 07:21:26353core.bare::
354If true this repository is assumed to be 'bare' and has no
355working directory associated with it. If this is the case a
356number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46357disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26358+
Junio C Hamano35738e82008-01-07 07:55:46359This setting is automatically guessed by linkgit:git-clone[1] or
360linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26361repository that ends in "/.git" is assumed to be not bare (bare =
362false), while all other repositories are assumed to be bare (bare
363= true).
364
Junio C Hamanod526ba92007-07-02 00:17:42365core.worktree::
Junio C Hamano80d58462011-01-24 22:52:52366Set the path to the root of the working tree.
Junio C Hamano764a6672007-10-23 01:23:31367This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano80d58462011-01-24 22:52:52368variable and the '--work-tree' command line option.
Junio C Hamano5cd15182011-04-05 00:21:10369The value can be an absolute path or relative to the path to
Junio C Hamano80d58462011-01-24 22:52:52370the .git directory, which is either specified by --git-dir
371or GIT_DIR, or automatically discovered.
372If --git-dir or GIT_DIR is specified but none of
Junio C Hamano7d575a52008-04-30 08:45:27373--work-tree, GIT_WORK_TREE and core.worktree is specified,
Junio C Hamano80d58462011-01-24 22:52:52374the current working directory is regarded as the top level
Junio C Hamano3609b332010-12-29 01:34:52375of your working tree.
Junio C Hamano80d58462011-01-24 22:52:52376+
377Note that this variable is honored even when set in a configuration
378file in a ".git" subdirectory of a directory and its value differs
379from the latter directory (e.g. "/path/to/.git/config" has
380core.worktree set to "/different/path"), which is most likely a
381misconfiguration. Running git commands in the "/path/to" directory will
382still use "/different/path" as the root of the work tree and can cause
383confusion unless you know what you are doing (e.g. you are creating a
384read-only snapshot of the same index to a location different from the
385repository's usual working tree).
Junio C Hamanod526ba92007-07-02 00:17:42386
Junio C Hamano341071d2006-06-04 07:24:48387core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49388Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48389"$GIT_DIR/logs/<ref>", by appending the new and old
390SHA1, the date/time and the reason of the update, but
391only when the file exists. If this configuration
392variable is set to true, missing "$GIT_DIR/logs/<ref>"
Junio C Hamano15567bc2011-07-23 00:51:59393file is automatically created for branch heads (i.e. under
394refs/heads/), remote refs (i.e. under refs/remotes/),
395note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
Junio C Hamano1caaf472006-12-31 08:29:35396+
397This information can be used to determine what commit
398was the tip of a branch "2 days ago".
399+
400This value is true by default in a repository that has
401a working directory associated with it, and false by
402default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48403
Junio C Hamano07824ce2006-04-25 07:36:54404core.repositoryFormatVersion::
405Internal variable identifying the repository format and layout
406version.
407
408core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42409When 'group' (or 'true'), the repository is made shareable between
410several users in a group (making sure all the files and objects are
411group-writable). When 'all' (or 'world' or 'everybody'), the
412repository will be readable by all users, additionally to being
413group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37414reported by umask(2). When '0xxx', where '0xxx' is an octal number,
415files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00416user's umask value (whereas the other options will only override
417requested parts of the user's umask value). Examples: '0660' will make
418the repo read/write-able for the owner and group, but inaccessible to
419others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37420repository that is group-readable but not group-writable.
421See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54422
423core.warnAmbiguousRefs::
424If true, git will warn you if the ref name you passed it is ambiguous
425and might match multiple refs in the .git/refs/ tree. True by default.
426
Junio C Hamano7ec15722006-07-07 02:03:59427core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09428An integer -1..9, indicating a default compression level.
429-1 is the zlib default. 0 means no compression,
430and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42431If set, this provides a default to other compression variables,
432such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26433
Junio C Hamanof2ce2972007-05-20 19:12:09434core.loosecompression::
435An integer -1..9, indicating the compression level for objects that
436are not in a pack file. -1 is the zlib default. 0 means no
437compression, and 1..9 are various speed/size tradeoffs, 9 being
438slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42439not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49440
Junio C Hamanofc4d38c2007-01-08 06:53:32441core.packedGitWindowSize::
442Number of bytes of a pack file to map into memory in a
443single mapping operation. Larger window sizes may allow
444your system to process a smaller number of large pack files
445more quickly. Smaller window sizes will negatively affect
446performance due to increased calls to the operating system's
447memory manager, but may improve performance when accessing
448a large number of large pack files.
449+
450Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
451MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
452be reasonable for all users/operating systems. You probably do
453not need to adjust this value.
454+
455Common unit suffixes of 'k', 'm', or 'g' are supported.
456
457core.packedGitLimit::
458Maximum number of bytes to map simultaneously into memory
459from pack files. If Git needs to access more than this many
460bytes at once to complete an operation it will unmap existing
461regions to reclaim virtual address space within the process.
462+
463Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
464This should be reasonable for all users/operating systems, except on
465the largest projects. You probably do not need to adjust this value.
466+
467Common unit suffixes of 'k', 'm', or 'g' are supported.
468
Junio C Hamanob8c51282007-03-19 10:43:30469core.deltaBaseCacheLimit::
470Maximum number of bytes to reserve for caching base objects
Junio C Hamano619596a2010-08-18 22:15:35471that may be referenced by multiple deltified objects. By storing the
Junio C Hamanob8c51282007-03-19 10:43:30472entire decompressed base objects in a cache Git is able
473to avoid unpacking and decompressing frequently used base
474objects multiple times.
475+
476Default is 16 MiB on all platforms. This should be reasonable
477for all users/operating systems, except on the largest projects.
478You probably do not need to adjust this value.
479+
480Common unit suffixes of 'k', 'm', or 'g' are supported.
481
Junio C Hamano5c246f22010-02-03 07:34:53482core.bigFileThreshold::
483Files larger than this size are stored deflated, without
484attempting delta compression. Storing large files without
485delta compression avoids excessive memory usage, at the
486slight expense of increased disk usage.
487+
488Default is 512 MiB on all platforms. This should be reasonable
489for most projects as source code and other text files can still
490be delta compressed, but larger binary media files won't be.
491+
492Common unit suffixes of 'k', 'm', or 'g' are supported.
Junio C Hamano5c246f22010-02-03 07:34:53493
Junio C Hamano1d90cb02007-07-03 07:05:31494core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37495In addition to '.gitignore' (per-directory) and
496'.git/info/exclude', git looks into this file for patterns
Junio C Hamanob76a6862012-05-02 22:02:46497of files which are not meant to be tracked. "`~/`" is expanded
498to the value of `$HOME` and "`~user/`" to the specified user's
Junio C Hamano8edb4c72012-07-09 20:33:55499home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
500If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
501is used instead. See linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37502
Junio C Hamano3fd7b262010-09-08 22:44:20503core.askpass::
504Some commands (e.g. svn and http interfaces) that interactively
505ask for a password can be told to use an external program given
506via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
507environment variable. If not set, fall back to the value of the
508'SSH_ASKPASS' environment variable or, failing that, a simple password
509prompt. The external program shall be given a suitable prompt as
510command line argument and write the password on its STDOUT.
511
Junio C Hamano3b4609d2010-09-30 00:04:34512core.attributesfile::
513In addition to '.gitattributes' (per-directory) and
514'.git/info/attributes', git looks into this file for attributes
515(see linkgit:gitattributes[5]). Path expansions are made the same
Junio C Hamano8edb4c72012-07-09 20:33:55516way as for `core.excludesfile`. Its default value is
517$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
518set or empty, $HOME/.config/git/attributes is used instead.
Junio C Hamano3b4609d2010-09-30 00:04:34519
Junio C Hamanof6002a92007-07-20 10:28:22520core.editor::
521Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27522messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22523variable when it is set, and the environment variable
Junio C Hamano3b70d3c2009-11-21 17:37:37524`GIT_EDITOR` is not set. See linkgit:git-var[1].
Junio C Hamanof6002a92007-07-20 10:28:22525
Junio C Hamano6231f822011-10-24 05:18:52526sequence.editor::
527Text editor used by `git rebase -i` for editing the rebase insn file.
528The value is meant to be interpreted by the shell when it is used.
529It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
530When not configured the default commit message editor is used instead.
531
Junio C Hamano28d8ede2007-07-05 05:51:38532core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33533The command that git will use to paginate output. Can
534be overridden with the `GIT_PAGER` environment
535variable. Note that git sets the `LESS` environment
536variable to `FRSX` if it is unset when it runs the
537pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42538`LESS` variable to some other value. Alternately,
539these settings can be overridden on a project or
540global basis by setting the `core.pager` option.
Junio C Hamanoa1295452012-11-13 22:32:04541Setting `core.pager` has no effect on the `LESS`
Junio C Hamanoa476efa2008-10-10 15:31:42542environment variable behaviour above, so if you want
543to override git's default settings this way, you need
544to be explicit. For example, to disable the S option
545in a backward compatible manner, set `core.pager`
Junio C Hamanoa1295452012-11-13 22:32:04546to `less -+S`. This will be passed to the shell by
547git, which will translate the final command to
548`LESS=FRSX less -+S`.
Junio C Hamano28d8ede2007-07-05 05:51:38549
Junio C Hamano942b35e2007-12-09 10:19:33550core.whitespace::
551A comma separated list of common whitespace problems to
Junio C Hamano1aa40d22010-01-21 17:46:43552notice. 'git diff' will use `color.diff.whitespace` to
553highlight them, and 'git apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59554consider them as errors. You can prefix `-` to disable
555any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33556+
Junio C Hamanob71a22d2009-10-17 08:23:47557* `blank-at-eol` treats trailing whitespaces at the end of the line
Junio C Hamano942b35e2007-12-09 10:19:33558 as an error (enabled by default).
559* `space-before-tab` treats a space character that appears immediately
560 before a tab character in the initial indent part of the line as an
561 error (enabled by default).
Junio C Hamano281fd392012-09-17 23:57:41562* `indent-with-non-tab` treats a line that is indented with space
563 characters instead of the equivalent tabs as an error (not enabled by
564 default).
Junio C Hamanocb39aea2010-05-09 07:24:48565* `tab-in-indent` treats a tab character in the initial indent part of
566 the line as an error (not enabled by default).
Junio C Hamanob71a22d2009-10-17 08:23:47567* `blank-at-eof` treats blank lines added at the end of file as an error
568 (enabled by default).
569* `trailing-space` is a short-hand to cover both `blank-at-eol` and
570 `blank-at-eof`.
Junio C Hamano601f3e52008-02-25 08:40:42571* `cr-at-eol` treats a carriage-return at the end of line as
572 part of the line terminator, i.e. with it, `trailing-space`
573 does not trigger if the character before such a carriage-return
574 is not a whitespace (not enabled by default).
Junio C Hamanoeef01fe2010-12-13 08:31:58575* `tabwidth=<n>` tells how many character positions a tab occupies; this
576 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
577 errors. The default tab width is 8. Allowed values are 1 to 63.
Junio C Hamano942b35e2007-12-09 10:19:33578
Junio C Hamano9eb57532008-06-26 06:33:46579core.fsyncobjectfiles::
580This boolean will enable 'fsync()' when writing object files.
581+
582This is a total waste of time and effort on a filesystem that orders
583data writes properly, but can be useful for filesystems that do not use
584journalling (traditional UNIX filesystems) or that only journal metadata
585and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
586
Junio C Hamano610d1762008-11-28 06:27:13587core.preloadindex::
588Enable parallel index preload for operations like 'git diff'
589+
590This can speed up operations like 'git diff' and 'git status' especially
591on filesystems like NFS that have weak caching semantics and thus
592relatively high IO latencies. With this set to 'true', git will do the
593index comparison to the filesystem data in parallel, allowing
594overlapping IO's.
595
Junio C Hamanoa9499de2009-04-30 03:38:48596core.createObject::
597You can set this to 'link', in which case a hardlink followed by
598a delete of the source are used to make sure that object creation
599will not overwrite existing objects.
600+
601On some file system/operating system combinations, this is unreliable.
602Set this config setting to 'rename' there; However, This will remove the
603check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41604
Junio C Hamano3b70d3c2009-11-21 17:37:37605core.notesRef::
606When showing commit messages, also show notes which are stored in
Junio C Hamanoa574a092010-06-13 19:57:10607the given ref. The ref must be fully qualified. If the given
608ref does not exist, it is not an error but means that no
609notes should be printed.
Junio C Hamano3b70d3c2009-11-21 17:37:37610+
Junio C Hamanoa574a092010-06-13 19:57:10611This setting defaults to "refs/notes/commits", and it can be overridden by
612the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
Junio C Hamano3b70d3c2009-11-21 17:37:37613
Junio C Hamano3c8d6702010-01-13 23:09:03614core.sparseCheckout::
615Enable "sparse checkout" feature. See section "Sparse checkout" in
616linkgit:git-read-tree[1] for more information.
617
Junio C Hamano6371b0e2011-03-23 23:36:21618core.abbrev::
619Set the length object names are abbreviated to. If unspecified,
620many commands abbreviate to 7 hexdigits, which may not be enough
621for abbreviated object names to stay unique for sufficiently long
622time.
623
Junio C Hamano3d141512009-06-01 01:22:40624add.ignore-errors::
Junio C Hamano60186642010-12-02 14:18:26625add.ignoreErrors::
Junio C Hamano1aa40d22010-01-21 17:46:43626Tells 'git add' to continue adding files when some files cannot be
Junio C Hamano3d141512009-06-01 01:22:40627added due to indexing errors. Equivalent to the '--ignore-errors'
Junio C Hamano60186642010-12-02 14:18:26628option of linkgit:git-add[1]. Older versions of git accept only
629`add.ignore-errors`, which does not follow the usual naming
630convention for configuration variables. Newer versions of git
631honor `add.ignoreErrors` as well.
Junio C Hamano3d141512009-06-01 01:22:40632
Junio C Hamano33db4372006-06-07 19:51:45633alias.*::
Junio C Hamano35738e82008-01-07 07:55:46634Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45635after defining "alias.last = cat-file commit HEAD", the invocation
636"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17637confusion and troubles with script usage, aliases that
638hide existing git commands are ignored. Arguments are split by
639spaces, the usual shell quoting and escaping is supported.
640quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39641+
642If the alias expansion is prefixed with an exclamation point,
643it will be treated as a shell command. For example, defining
644"alias.new = !gitk --all --not ORIG_HEAD", the invocation
645"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19646"gitk --all --not ORIG_HEAD". Note that shell commands will be
647executed from the top-level directory of a repository, which may
648not necessarily be the current directory.
Junio C Hamano5f2627d2011-05-06 20:23:48649'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
650from the original current directory. See linkgit:git-rev-parse[1].
Junio C Hamano9cb74f22007-02-12 04:15:05651
Junio C Hamanocaa712a2010-03-11 01:17:35652am.keepcr::
653If true, git-am will call git-mailsplit for patches in mbox format
654with parameter '--keep-cr'. In this case git-mailsplit will
Junio C Hamano619596a2010-08-18 22:15:35655not remove `\r` from lines ending with `\r\n`. Can be overridden
Junio C Hamanocaa712a2010-03-11 01:17:35656by giving '--no-keep-cr' from the command line.
657See linkgit:git-am[1], linkgit:git-mailsplit[1].
658
Junio C Hamanofe24db02009-08-22 05:10:47659apply.ignorewhitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43660When set to 'change', tells 'git apply' to ignore changes in
Junio C Hamanofe24db02009-08-22 05:10:47661whitespace, in the same way as the '--ignore-space-change'
662option.
Junio C Hamano1aa40d22010-01-21 17:46:43663When set to one of: no, none, never, false tells 'git apply' to
Junio C Hamanofe24db02009-08-22 05:10:47664respect all whitespace differences.
665See linkgit:git-apply[1].
666
Junio C Hamano07824ce2006-04-25 07:36:54667apply.whitespace::
Junio C Hamano1aa40d22010-01-21 17:46:43668Tells 'git apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46669as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54670
Junio C Hamano7fd84172007-05-24 07:00:32671branch.autosetupmerge::
Junio C Hamano1aa40d22010-01-21 17:46:43672Tells 'git branch' and 'git checkout' to set up new branches
Junio C Hamano24bc09a2008-02-28 00:27:44673so that linkgit:git-pull[1] will appropriately merge from the
674starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32675this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44676and `--no-track` options. The valid settings are: `false` -- no
677automatic setup is done; `true` -- automatic setup is done when the
Junio C Hamano97bcb482010-11-25 03:16:07678starting point is a remote-tracking branch; `always` --
679automatic setup is done when the starting point is either a
680local branch or remote-tracking
Junio C Hamano24bc09a2008-02-28 00:27:44681branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32682
Junio C Hamano869bb802008-05-12 00:29:47683branch.autosetuprebase::
Junio C Hamano1aa40d22010-01-21 17:46:43684When a new branch is created with 'git branch' or 'git checkout'
Junio C Hamano869bb802008-05-12 00:29:47685that tracks another branch, this variable tells git to set
686up pull to rebase instead of merge (see "branch.<name>.rebase").
687When `never`, rebase is never automatically set to true.
688When `local`, rebase is set to true for tracked branches of
689other local branches.
690When `remote`, rebase is set to true for tracked branches of
Junio C Hamano97bcb482010-11-25 03:16:07691remote-tracking branches.
Junio C Hamano869bb802008-05-12 00:29:47692When `always`, rebase will be set to true for all tracking
693branches.
694See "branch.autosetupmerge" for details on how to set up a
695branch to track another branch.
696This option defaults to never.
697
Junio C Hamano47c1e3c2006-09-25 04:45:55698branch.<name>.remote::
Junio C Hamano1aa40d22010-01-21 17:46:43699When in branch <name>, it tells 'git fetch' and 'git push' which
Junio C Hamano0706c802009-03-30 22:34:19700remote to fetch from/push to. It defaults to `origin` if no remote is
701configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55702
703branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19704Defines, together with branch.<name>.remote, the upstream branch
Junio C Hamanob02377c2011-04-28 22:26:02705for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
Junio C Hamano1aa40d22010-01-21 17:46:43706branch to merge and can also affect 'git push' (see push.default).
707When in branch <name>, it tells 'git fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31708refspec to be marked for merging in FETCH_HEAD. The value is
709handled like the remote part of a refspec, and must match a
710ref which is fetched from the remote given by
711"branch.<name>.remote".
Junio C Hamano1aa40d22010-01-21 17:46:43712The merge information is used by 'git pull' (which at first calls
713'git fetch') to lookup the default branch for merging. Without
714this option, 'git pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46715Specify multiple values to get an octopus merge.
Junio C Hamano1aa40d22010-01-21 17:46:43716If you wish to setup 'git pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07717another branch in the local repository, you can point
718branch.<name>.merge to the desired branch, and use the special setting
719`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55720
Junio C Hamano1b50ce92007-10-03 12:05:53721branch.<name>.mergeoptions::
722Sets default options for merging into branch <name>. The syntax and
Junio C Hamanoc0e55e72009-10-10 00:56:29723supported options are the same as those of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53724option values containing whitespace characters are currently not
725supported.
726
Junio C Hamano0c999702007-12-03 09:57:55727branch.<name>.rebase::
728When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08729instead of merging the default branch from the default remote when
Junio C Hamano515ab1d2011-12-09 23:41:20730"git pull" is run. See "pull.rebase" for doing this in a non
731branch-specific manner.
732+
733*NOTE*: this is a possibly dangerous operation; do *not* use
734it unless you understand the implications (see linkgit:git-rebase[1]
735for details).
Junio C Hamano0c999702007-12-03 09:57:55736
Junio C Hamano8760ea62008-03-14 08:58:45737browser.<tool>.cmd::
738Specify the command to invoke the specified browser. The
739specified command is evaluated in shell with the URLs passed
Junio C Hamano360e3a12011-07-13 23:51:56740as arguments. (See linkgit:git-web{litdd}browse[1].)
Junio C Hamano8760ea62008-03-14 08:58:45741
Junio C Hamanoe35a6fc2008-01-29 09:46:27742browser.<tool>.path::
743Override the path for the given tool that may be used to
744browse HTML help (see '-w' option in linkgit:git-help[1]) or a
745working repository in gitweb (see linkgit:git-instaweb[1]).
746
Junio C Hamano47b9acd2007-04-24 07:34:34747clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45748A boolean to make git-clean do nothing unless given -f
749or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34750
Junio C Hamanoeb692952007-01-03 22:02:12751color.branch::
752A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46753linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21754`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12755only when the output is to a terminal. Defaults to false.
756
757color.branch.<slot>::
758Use customized color for branch coloration. `<slot>` is one of
759`current` (the current branch), `local` (a local branch),
Junio C Hamano97bcb482010-11-25 03:16:07760`remote` (a remote-tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22761refs).
762+
763The value for these configuration variables is a list of colors (at most
764two) and attributes (at most one), separated by spaces. The colors
765accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
766`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
767`blink` and `reverse`. The first color given is the foreground; the
768second is the background. The position of the attribute, if any,
769doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12770
Junio C Hamano3f403b02006-12-13 10:14:13771color.diff::
Junio C Hamano5f2627d2011-05-06 20:23:48772Whether to use ANSI escape sequences to add color to patches.
773If this is set to `always`, linkgit:git-diff[1],
774linkgit:git-log[1], and linkgit:git-show[1] will use color
775for all patches. If it is set to `true` or `auto`, those
776commands will only use color when output is to the terminal.
777Defaults to false.
778+
779This does not affect linkgit:git-format-patch[1] nor the
780'git-diff-{asterisk}' plumbing commands. Can be overridden on the
781command line with the `--color[=<when>]` option.
Junio C Hamano9ae1a062006-07-10 08:12:34782
Junio C Hamano3f403b02006-12-13 10:14:13783color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22784Use customized color for diff colorization. `<slot>` specifies
785which part of the patch to use the specified color, and is one
786of `plain` (context text), `meta` (metainformation), `frag`
Junio C Hamano2bd8a742009-12-01 21:16:59787(hunk header), 'func' (function in hunk header), `old` (removed lines),
788`new` (added lines), `commit` (commit headers), or `whitespace`
789(highlighting whitespace errors). The values of these variables may be
790specified as in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34791
Junio C Hamano7d449522010-07-01 00:08:51792color.decorate.<slot>::
793Use customized color for 'git log --decorate' output. `<slot>` is one
794of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
Junio C Hamano97bcb482010-11-25 03:16:07795branches, remote-tracking branches, tags, stash and HEAD, respectively.
Junio C Hamano7d449522010-07-01 00:08:51796
Junio C Hamanod257cff2009-03-18 05:27:16797color.grep::
798When set to `always`, always highlight matches. When `false` (or
799`never`), never. When set to `true` or `auto`, use color only
800when the output is written to the terminal. Defaults to `false`.
801
Junio C Hamano0299d922010-03-20 20:59:31802color.grep.<slot>::
803Use customized color for grep colorization. `<slot>` specifies which
804part of the line to use the specified color, and is one of
805+
806--
807`context`;;
808non-matching text in context lines (when using `-A`, `-B`, or `-C`)
809`filename`;;
810filename prefix (when not using `-h`)
811`function`;;
812function name lines (when using `-p`)
813`linenumber`;;
814line number prefix (when using `-n`)
815`match`;;
816matching text
817`selected`;;
818non-matching text in selected lines
819`separator`;;
820separators between fields on a line (`:`, `-`, and `=`)
821and between hunks (`--`)
822--
823+
824The values of these variables may be specified as in color.branch.<slot>.
Junio C Hamanod257cff2009-03-18 05:27:16825
Junio C Hamano00b8b632007-12-07 09:50:49826color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46827When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31828and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49829When false (or `never`), never. When set to `true` or `auto`, use
830colors only when the output is to the terminal. Defaults to false.
831
832color.interactive.<slot>::
Junio C Hamano1aa40d22010-01-21 17:46:43833Use customized color for 'git add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10834output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
835four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00836commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49837in color.branch.<slot>.
838
Junio C Hamanoe7935c42006-12-13 21:32:17839color.pager::
840A boolean to enable/disable colored output when the pager is in
841use (default is true).
842
Junio C Hamano52ba2952009-05-18 17:43:02843color.showbranch::
844A boolean to enable/disable color in the output of
845linkgit:git-show-branch[1]. May be set to `always`,
846`false` (or `never`) or `auto` (or `true`), in which case colors are used
847only when the output is to a terminal. Defaults to false.
848
Junio C Hamanoe7935c42006-12-13 21:32:17849color.status::
850A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46851linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21852`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17853only when the output is to a terminal. Defaults to false.
854
855color.status.<slot>::
856Use customized color for status colorization. `<slot>` is
857one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04858`added` or `updated` (files which are added but not committed),
859`changed` (files which are changed but not added in the index),
Junio C Hamano0d75e872010-12-17 06:57:26860`untracked` (files which are not tracked by git),
861`branch` (the current branch), or
Junio C Hamanob713ff12008-05-24 01:12:30862`nobranch` (the color the 'no branch' warning is shown in, defaulting
863to red). The values of these variables may be specified as in
864color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17865
Junio C Hamano83d46a22008-02-21 02:29:42866color.ui::
Junio C Hamano5f2627d2011-05-06 20:23:48867This variable determines the default value for variables such
868as `color.diff` and `color.grep` that control the use of color
869per command family. Its scope will expand as more commands learn
870configuration to set a default for the `--color` option. Set it
871to `always` if you want all output not intended for machine
872consumption to use color, to `true` or `auto` if you want such
873output to use color when written to the terminal, or to `false` or
874`never` if you prefer git commands not to use color unless enabled
875explicitly with some other configuration or the `--color` option.
Junio C Hamano83d46a22008-02-21 02:29:42876
Junio C Hamano22700fb2012-05-03 23:07:25877column.ui::
878Specify whether supported commands should output in columns.
879This variable consists of a list of tokens separated by spaces
880or commas:
881+
882--
883`always`;;
884always show in columns
885`never`;;
886never show in columns
887`auto`;;
888show in columns if the output is to the terminal
889`column`;;
890fill columns before rows (default)
891`row`;;
892fill rows before columns
893`plain`;;
894show in one column
895`dense`;;
896make unequal size columns to utilize more space
897`nodense`;;
898make equal size columns
899--
900+
Junio C Hamanobcaa8bc2012-07-03 22:17:20901This option defaults to 'never'.
Junio C Hamano22700fb2012-05-03 23:07:25902
903column.branch::
904Specify whether to output branch listing in `git branch` in columns.
905See `column.ui` for details.
906
907column.status::
908Specify whether to output untracked files in `git status` in columns.
909See `column.ui` for details.
910
911column.tag::
912Specify whether to output tag listing in `git tag` in columns.
913See `column.ui` for details.
914
Junio C Hamanod0d892c2010-01-24 20:06:29915commit.status::
Junio C Hamano6ce6b6c2010-01-18 01:25:50916A boolean to enable/disable inclusion of status information in the
917commit message template when using an editor to prepare the commit
918message. Defaults to true.
919
Junio C Hamano4653c6f2008-11-26 22:50:20920commit.template::
921Specify a file to use as the template for new commit messages.
Junio C Hamanob76a6862012-05-02 22:02:46922"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
Junio C Hamanobf984de2009-11-23 06:11:19923specified user's home directory.
Junio C Hamano4653c6f2008-11-26 22:50:20924
Junio C Hamano0df92712011-12-21 22:30:44925credential.helper::
926Specify an external helper to be called when a username or
927password credential is needed; the helper may consult external
928storage to avoid prompting the user for the credentials. See
929linkgit:gitcredentials[7] for details.
930
931credential.useHttpPath::
932When acquiring credentials, consider the "path" component of an http
933or https URL to be important. Defaults to false. See
934linkgit:gitcredentials[7] for more information.
935
936credential.username::
937If no username is set for a network authentication, use this username
938by default. See credential.<context>.* below, and
939linkgit:gitcredentials[7].
940
941credential.<url>.*::
942Any of the credential.* options above can be applied selectively to
943some credentials. For example "credential.https://example.com.username"
944would set the default username only for https connections to
945example.com. See linkgit:gitcredentials[7] for details on how URLs are
946matched.
947
Junio C Hamano209ebe82011-04-27 21:09:59948include::diff-config.txt[]
Junio C Hamano3bd66e92009-04-18 06:17:56949
950difftool.<tool>.path::
951Override the path for the given tool. This is useful in case
952your tool is not in the PATH.
953
954difftool.<tool>.cmd::
955Specify the command to invoke the specified diff tool.
956The specified command is evaluated in shell with the following
957variables available: 'LOCAL' is set to the name of the temporary
958file containing the contents of the diff pre-image and 'REMOTE'
959is set to the name of the temporary file containing the contents
960of the diff post-image.
961
962difftool.prompt::
963Prompt before each invocation of the diff tool.
964
Junio C Hamano0d75e872010-12-17 06:57:26965fetch.recurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:10966This option can be either set to a boolean value or to 'on-demand'.
967Setting it to a boolean changes the behavior of fetch and pull to
968unconditionally recurse into submodules when set to true or to not
969recurse at all when set to false. When set to 'on-demand' (the default
970value), fetch and pull will only recurse into a populated submodule
971when its superproject retrieves a commit that updates the submodule's
972reference.
Junio C Hamano0d75e872010-12-17 06:57:26973
Junio C Hamano8fb66e52011-10-05 20:59:51974fetch.fsckObjects::
975If it is set to true, git-fetch-pack will check all fetched
976objects. It will abort in the case of a malformed object or a
977broken link. The result of an abort are only dangling objects.
978Defaults to false. If not set, the value of `transfer.fsckObjects`
979is used instead.
980
Junio C Hamano54ea8d32007-01-25 07:59:48981fetch.unpackLimit::
982If the number of objects fetched over the git native
983transfer is below this
984limit, then the objects will be unpacked into loose object
985files. However if the number of received objects equals or
986exceeds this limit then the received pack will be stored as
987a pack, after adding any missing delta bases. Storing the
988pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17989especially on slow filesystems. If not set, the value of
990`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48991
Junio C Hamanof4581102009-04-25 08:29:59992format.attach::
993Enable multipart/mixed attachments as the default for
994'format-patch'. The value can also be a double quoted string
995which will enable attachments as the default and set the
996value as the boundary. See the --attach option in
997linkgit:git-format-patch[1].
998
Junio C Hamano8c5802d2007-11-15 00:13:36999format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:331000A boolean which can enable or disable sequence numbers in patch
1001subjects. It defaults to "auto" which enables it only if there
1002is more than one patch. It can be enabled or disabled for all
1003messages by setting it to "true" or "false". See --numbered
1004option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:361005
Junio C Hamano07824ce2006-04-25 07:36:541006format.headers::
1007Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:461008by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:541009
Junio C Hamano70664a02010-07-13 22:48:051010format.to::
Junio C Hamanof4581102009-04-25 08:29:591011format.cc::
Junio C Hamano70664a02010-07-13 22:48:051012Additional recipients to include in a patch to be submitted
1013by mail. See the --to and --cc options in
1014linkgit:git-format-patch[1].
Junio C Hamanof4581102009-04-25 08:29:591015
1016format.subjectprefix::
1017The default for format-patch is to output files with the '[PATCH]'
1018subject prefix. Use this variable to change that prefix.
1019
Junio C Hamano89a57342010-06-22 23:22:551020format.signature::
1021The default for format-patch is to output a signature containing
1022the git version number. Use this variable to change that default.
1023Set this variable to the empty string ("") to suppress
1024signature generation.
1025
Junio C Hamanod4c8e112007-03-04 10:32:381026format.suffix::
1027The default for format-patch is to output files with the suffix
1028`.patch`. Use this variable to change that suffix (make sure to
1029include the dot if you want it).
1030
Junio C Hamano86bcccc2008-03-08 09:33:551031format.pretty::
1032The default pretty format for log/show/whatchanged command,
1033See linkgit:git-log[1], linkgit:git-show[1],
1034linkgit:git-whatchanged[1].
1035
Junio C Hamanoea6a7642009-03-11 23:56:191036format.thread::
Junio C Hamano1aa40d22010-01-21 17:46:431037The default threading style for 'git format-patch'. Can be
Junio C Hamanob141a922010-01-10 19:55:141038a boolean value, or `shallow` or `deep`. `shallow` threading
1039makes every mail a reply to the head of the series,
Junio C Hamanoea6a7642009-03-11 23:56:191040where the head is chosen from the cover letter, the
Junio C Hamanob76a6862012-05-02 22:02:461041`--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:591042`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:191043A true boolean value is the same as `shallow`, and a false
1044value disables threading.
1045
Junio C Hamano5f9a6f02009-04-06 08:26:561046format.signoff::
1047 A boolean value which lets you enable the `-s/--signoff` option of
1048 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1049 patch should be a conscious act and means that you certify you have
1050 the rights to submit this work under the same open source license.
1051 Please see the 'SubmittingPatches' document for further discussion.
1052
Junio C Hamano209ebe82011-04-27 21:09:591053filter.<driver>.clean::
1054The command which is used to convert the content of a worktree
1055file to a blob upon checkin. See linkgit:gitattributes[5] for
1056details.
1057
1058filter.<driver>.smudge::
1059The command which is used to convert the content of a blob
1060object to a worktree file upon checkout. See
1061linkgit:gitattributes[5] for details.
1062
Junio C Hamanof2ce2972007-05-20 19:12:091063gc.aggressiveWindow::
1064The window size parameter used in the delta compression
Junio C Hamano1aa40d22010-01-21 17:46:431065algorithm used by 'git gc --aggressive'. This defaults
Junio C Hamanob04bb3f2010-04-14 14:07:361066to 250.
Junio C Hamanof2ce2972007-05-20 19:12:091067
Junio C Hamano1b50ce92007-10-03 12:05:531068gc.auto::
1069When there are approximately more than this many loose
1070objects in the repository, `git gc --auto` will pack them.
1071Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:171072light-weight garbage collection from time to time. The
1073default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531074
1075gc.autopacklimit::
1076When there are more than this many packs that are not
1077marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:171078--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:371079default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:531080
Junio C Hamano9d52e572007-02-13 23:48:201081gc.packrefs::
Junio C Hamanob141a922010-01-10 19:55:141082Running `git pack-refs` in a repository renders it
1083unclonable by Git versions prior to 1.5.1.2 over dumb
1084transports such as HTTP. This variable determines whether
Junio C Hamanocdd1c332010-12-20 10:08:001085'git gc' runs `git pack-refs`. This can be set to `notbare`
Junio C Hamanob141a922010-01-10 19:55:141086to enable it within all non-bare repos or it can be set to a
1087boolean value. The default is `true`.
Junio C Hamano9d52e572007-02-13 23:48:201088
Junio C Hamano09a926d2008-03-13 07:55:291089gc.pruneexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431090When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:571091Override the grace period with this config variable. The value
1092"now" may be used to disable this grace period and always prune
1093unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:291094
Junio C Hamano74640642006-12-27 10:59:551095gc.reflogexpire::
Junio C Hamanocc7636a2010-05-21 14:57:531096gc.<pattern>.reflogexpire::
Junio C Hamano1aa40d22010-01-21 17:46:431097'git reflog expire' removes reflog entries older than
Junio C Hamanocc7636a2010-05-21 14:57:531098this time; defaults to 90 days. With "<pattern>" (e.g.
1099"refs/stash") in the middle the setting applies only to
1100the refs that match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551101
1102gc.reflogexpireunreachable::
Junio C Hamanocc7636a2010-05-21 14:57:531103gc.<ref>.reflogexpireunreachable::
Junio C Hamano1aa40d22010-01-21 17:46:431104'git reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:551105this time and are not reachable from the current tip;
Junio C Hamanocc7636a2010-05-21 14:57:531106defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1107in the middle, the setting applies only to the refs that
1108match the <pattern>.
Junio C Hamano74640642006-12-27 10:59:551109
1110gc.rerereresolved::
1111Records of conflicted merge you resolved earlier are
Junio C Hamano1aa40d22010-01-21 17:46:431112kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461113The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551114
1115gc.rerereunresolved::
1116Records of conflicted merge you have not resolved are
Junio C Hamano1aa40d22010-01-21 17:46:431117kept for this many days when 'git rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:461118The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:551119
Junio C Hamanoa3148f52009-01-14 08:49:571120gitcvs.commitmsgannotation::
1121Append this string to each commit message. Set to empty string
1122to disable this feature. Defaults to "via git-CVS emulator".
1123
Junio C Hamano07824ce2006-04-25 07:36:541124gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:271125Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:461126See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541127
1128gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:271129Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:461130various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:541131
Junio C Hamano17bd2272008-09-01 06:11:171132gitcvs.usecrlfattr::
Junio C Hamanobb88cf42010-06-21 15:23:551133If true, the server will look up the end-of-line conversion
1134attributes for files to determine the '-k' modes to use. If
1135the attributes force git to treat a file as text,
Junio C Hamano619596a2010-08-18 22:15:351136the '-k' mode will be left blank so CVS clients will
Junio C Hamanobb88cf42010-06-21 15:23:551137treat it as text. If they suppress text conversion, the file
Junio C Hamanocb1c44f2008-08-06 06:19:331138will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanobb88cf42010-06-21 15:23:551139the client might otherwise do. If the attributes do not allow
1140the file type to be determined, then 'gitcvs.allbinary' is
1141used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:141142
Junio C Hamanod9e0e5d2007-04-14 16:22:041143gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:141144This is used if 'gitcvs.usecrlfattr' does not resolve
1145the correct '-kb' mode to use. If true, all
1146unresolved files are sent to the client in
1147mode '-kb'. This causes the client to treat them
1148as binary files, which suppresses any newline munging it
1149otherwise might do. Alternatively, if it is set to "guess",
1150then the contents of the file are examined to decide if
1151it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:041152
1153gitcvs.dbname::
1154Database used by git-cvsserver to cache revision information
1155derived from the git repository. The exact meaning depends on the
1156used database driver, for SQLite (which is the default driver) this
1157is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461158linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:041159Default: '%Ggitcvs.%m.sqlite'
1160
1161gitcvs.dbdriver::
1162Used Perl DBI driver. You can specify any available driver
1163 for this here, but it might not work. git-cvsserver is tested
1164with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1165reported *not* to work with 'DBD::mysql'. Experimental feature.
1166May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:461167See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:041168
Junio C Hamanoa2ad99e2007-04-18 09:57:041169gitcvs.dbuser, gitcvs.dbpass::
1170Database user and password. Only useful if setting 'gitcvs.dbdriver',
1171since SQLite has no concept of database users and/or passwords.
1172'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:461173linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:041174
Junio C Hamanoa74efce2008-04-02 08:39:081175gitcvs.dbTableNamePrefix::
1176Database table name prefix. Prepended to the names of any
1177database tables used, allowing a single database to be used
1178for several repositories. Supports variable substitution (see
1179linkgit:git-cvsserver[1] for details). Any non-alphabetic
1180characters will be replaced with underscores.
1181
Junio C Hamanodfccbb02008-05-26 01:16:141182All gitcvs variables except for 'gitcvs.usecrlfattr' and
1183'gitcvs.allbinary' can also be specified as
1184'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:271185is one of "ext" and "pserver") to make them apply only for the given
1186access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:041187
Junio C Hamano11821ed2011-10-19 18:42:091188gitweb.category::
1189gitweb.description::
1190gitweb.owner::
1191gitweb.url::
1192See linkgit:gitweb[1] for description.
1193
1194gitweb.avatar::
1195gitweb.blame::
1196gitweb.grep::
1197gitweb.highlight::
1198gitweb.patches::
1199gitweb.pickaxe::
1200gitweb.remote_heads::
1201gitweb.showsizes::
1202gitweb.snapshot::
1203See linkgit:gitweb.conf[5] for description.
1204
Junio C Hamanoa03ac862011-04-02 04:32:291205grep.lineNumber::
1206If set to true, enable '-n' option by default.
1207
Junio C Hamanoa00504d2012-08-27 21:11:231208grep.patternType::
1209Set the default matching behavior. Using a value of 'basic', 'extended',
1210'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1211'--fixed-strings', or '--perl-regexp' option accordingly, while the
1212value 'default' will return to the default matching behavior.
1213
Junio C Hamanoa03ac862011-04-02 04:32:291214grep.extendedRegexp::
Junio C Hamanoa00504d2012-08-27 21:11:231215If set to true, enable '--extended-regexp' option by default. This
1216option is ignored when the 'grep.patternType' option is set to a value
1217other than 'default'.
Junio C Hamanoa03ac862011-04-02 04:32:291218
Junio C Hamano4fd24422012-01-06 21:52:431219gpg.program::
1220Use this custom program instead of "gpg" found on $PATH when
1221making or verifying a PGP signature. The program must support the
1222same command line interface as GPG, namely, to verify a detached
1223signature, "gpg --verify $file - <$signature" is run, and the
1224program is expected to signal a good signature by exiting with
1225code 0, and to generate an ascii-armored detached signature, the
1226standard input of "gpg -bsau $key" is fed with the contents to be
1227signed, and the program is expected to send the result to its
1228standard output.
1229
Junio C Hamano6d76d612008-05-09 05:46:081230gui.commitmsgwidth::
1231Defines how wide the commit message window is in the
1232linkgit:git-gui[1]. "75" is the default.
1233
1234gui.diffcontext::
1235Specifies how many context lines should be used in calls to diff
1236made by the linkgit:git-gui[1]. The default is "5".
1237
Junio C Hamanod3452a02008-11-15 08:07:551238gui.encoding::
1239Specifies the default encoding to use for displaying of
1240file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1241It can be overridden by setting the 'encoding' attribute
1242for relevant files (see linkgit:gitattributes[5]).
1243If this option is not set, the tools default to the
1244locale encoding.
1245
Junio C Hamano6d76d612008-05-09 05:46:081246gui.matchtrackingbranch::
1247Determines if new branches created with linkgit:git-gui[1] should
1248default to tracking remote branches with matching names or
1249not. Default: "false".
1250
1251gui.newbranchtemplate::
1252Is used as suggested name when creating new branches using the
1253linkgit:git-gui[1].
1254
1255gui.pruneduringfetch::
Junio C Hamano97bcb482010-11-25 03:16:071256"true" if linkgit:git-gui[1] should prune remote-tracking branches when
Junio C Hamano6d76d612008-05-09 05:46:081257performing a fetch. The default value is "false".
1258
1259gui.trustmtime::
1260Determines if linkgit:git-gui[1] should trust the file modification
1261timestamp or not. By default the timestamps are not trusted.
1262
1263gui.spellingdictionary::
1264Specifies the dictionary used for spell checking commit messages in
1265the linkgit:git-gui[1]. When set to "none" spell checking is turned
1266off.
1267
Junio C Hamanod3452a02008-11-15 08:07:551268gui.fastcopyblame::
Junio C Hamano1aa40d22010-01-21 17:46:431269If true, 'git gui blame' uses `-C` instead of `-C -C` for original
Junio C Hamanod3452a02008-11-15 08:07:551270location detection. It makes blame significantly faster on huge
1271repositories at the expense of less thorough copy detection.
1272
1273gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:131274Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:551275detection, measured in alphanumeric characters. See the
1276linkgit:git-blame[1] manual for more information on copy detection.
1277
1278gui.blamehistoryctx::
1279Specifies the radius of history context in days to show in
1280linkgit:gitk[1] for the selected commit, when the `Show History
1281Context` menu item is invoked from 'git gui blame'. If this
1282variable is set to zero, the whole history is shown.
1283
Junio C Hamano92d312a2008-12-15 07:22:201284guitool.<name>.cmd::
1285Specifies the shell command line to execute when the corresponding item
1286of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1287mandatory for every tool. The command is executed from the root of
1288the working directory, and in the environment it receives the name of
1289the tool as 'GIT_GUITOOL', the name of the currently selected file as
1290'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1291the head is detached, 'CUR_BRANCH' is empty).
1292
1293guitool.<name>.needsfile::
1294Run the tool only if a diff is selected in the GUI. It guarantees
1295that 'FILENAME' is not empty.
1296
1297guitool.<name>.noconsole::
1298Run the command silently, without creating a window to display its
1299output.
1300
1301guitool.<name>.norescan::
1302Don't rescan the working directory for changes after the tool
1303finishes execution.
1304
1305guitool.<name>.confirm::
1306Show a confirmation dialog before actually running the tool.
1307
1308guitool.<name>.argprompt::
1309Request a string argument from the user, and pass it to the tool
1310through the 'ARGS' environment variable. Since requesting an
1311argument implies confirmation, the 'confirm' option has no effect
1312if this is enabled. If the option is set to 'true', 'yes', or '1',
1313the dialog uses a built-in generic prompt; otherwise the exact
1314value of the variable is used.
1315
1316guitool.<name>.revprompt::
1317Request a single valid revision from the user, and set the
1318'REVISION' environment variable. In other aspects this option
1319is similar to 'argprompt', and can be used together with it.
1320
1321guitool.<name>.revunmerged::
1322Show only unmerged branches in the 'revprompt' subdialog.
1323This is useful for tools similar to merge or rebase, but not
1324for things like checkout or reset.
1325
1326guitool.<name>.title::
1327Specifies the title to use for the prompt dialog. The default
1328is the tool name.
1329
1330guitool.<name>.prompt::
1331Specifies the general prompt string to display at the top of
1332the dialog, before subsections for 'argprompt' and 'revprompt'.
1333The default value includes the actual command.
1334
Junio C Hamano4e272312008-01-08 09:13:211335help.browser::
1336Specify the browser that will be used to display help in the
1337'web' format. See linkgit:git-help[1].
1338
1339help.format::
1340Override the default help format used by linkgit:git-help[1].
1341Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1342the default. 'web' and 'html' are the same.
1343
Junio C Hamanof24b8062008-09-09 01:34:391344help.autocorrect::
1345Automatically correct and execute mistyped commands after
1346waiting for the given number of deciseconds (0.1 sec). If more
1347than one command can be deduced from the entered text, nothing
1348will be executed. If the value of this option is negative,
1349the corrected command will be executed immediately. If the
1350value is 0 - the command will be just shown but not executed.
1351This is the default.
1352
Junio C Hamano58256872007-12-04 08:31:131353http.proxy::
Junio C Hamano3dd93922012-03-05 07:49:111354Override the HTTP proxy, normally configured using the 'http_proxy',
1355'https_proxy', and 'all_proxy' environment variables (see
1356`curl(1)`). This can be overridden on a per-remote basis; see
1357remote.<name>.proxy
Junio C Hamano58256872007-12-04 08:31:131358
Junio C Hamano4c4b0122011-06-30 01:19:321359http.cookiefile::
1360File containing previously stored cookie lines which should be used
1361in the git http session, if they match the server. The file format
1362of the file to read cookies from should be plain HTTP headers or
1363the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1364NOTE that the file specified with http.cookiefile is only used as
1365input. No cookies will be stored in the file.
1366
Junio C Hamano07824ce2006-04-25 07:36:541367http.sslVerify::
1368Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451369over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541370variable.
1371
1372http.sslCert::
1373File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451374over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541375variable.
1376
1377http.sslKey::
1378File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481379over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541380variable.
1381
Junio C Hamano48bc1ce2009-07-09 16:49:191382http.sslCertPasswordProtected::
1383Enable git's password prompt for the SSL certificate. Otherwise
1384OpenSSL will prompt the user, possibly many times, if the
1385certificate or private key is encrypted. Can be overridden by the
1386'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1387
Junio C Hamano07824ce2006-04-25 07:36:541388http.sslCAInfo::
1389File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481390fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541391'GIT_SSL_CAINFO' environment variable.
1392
1393http.sslCAPath::
1394Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451395with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541396by the 'GIT_SSL_CAPATH' environment variable.
1397
1398http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481399How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541400by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1401
Junio C Hamanob141a922010-01-10 19:55:141402http.minSessions::
1403The number of curl sessions (counted across slots) to be kept across
1404requests. They will not be ended with curl_easy_cleanup() until
1405http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1406value will be capped at 1. Defaults to 1.
1407
Junio C Hamano3b70d3c2009-11-21 17:37:371408http.postBuffer::
1409Maximum size in bytes of the buffer used by smart HTTP
1410transports when POSTing data to the remote system.
1411For requests larger than this buffer size, HTTP/1.1 and
1412Transfer-Encoding: chunked is used to avoid creating a
1413massive pack file locally. Default is 1 MiB, which is
1414sufficient for most requests.
1415
Junio C Hamano07824ce2006-04-25 07:36:541416http.lowSpeedLimit, http.lowSpeedTime::
1417If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1418for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481419Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541420'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1421
Junio C Hamanof1dcdfe2006-09-29 08:10:511422http.noEPSV::
1423A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041424This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511425support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1426environment variable. Default is false (curl will use EPSV).
1427
Junio C Hamano53ba6d02010-08-22 07:25:121428http.useragent::
1429The HTTP USER_AGENT string presented to an HTTP server. The default
1430value represents the version of the client git such as git/1.7.1.
1431This option allows you to override this value to a more common value
1432such as Mozilla/4.0. This may be necessary, for instance, if
1433connecting through a firewall that restricts HTTP connections to a set
1434of common USER_AGENT strings (but not including those like git/1.7.1).
1435Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1436
Junio C Hamano07824ce2006-04-25 07:36:541437i18n.commitEncoding::
1438Character encoding the commit messages are stored in; git itself
1439does not care per se, but this information is necessary e.g. when
1440importing commits from emails or in the gitk graphical history
1441browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461442porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541443
Junio C Hamano51f92e22006-12-29 05:18:281444i18n.logOutputEncoding::
1445Character encoding the commit messages are converted to when
Junio C Hamano1aa40d22010-01-21 17:46:431446running 'git log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281447
Junio C Hamano4653c6f2008-11-26 22:50:201448imap::
1449The configuration variables in the 'imap' section are described
1450in linkgit:git-imap-send[1].
1451
Junio C Hamanocaa712a2010-03-11 01:17:351452init.templatedir::
1453Specify the directory from which templates will be copied.
1454(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1455
Junio C Hamano4e272312008-01-08 09:13:211456instaweb.browser::
1457Specify the program that will be used to browse your working
1458repository in gitweb. See linkgit:git-instaweb[1].
1459
1460instaweb.httpd::
1461The HTTP daemon command-line to start gitweb on your working
1462repository. See linkgit:git-instaweb[1].
1463
1464instaweb.local::
1465If true the web server started by linkgit:git-instaweb[1] will
1466be bound to the local IP (127.0.0.1).
1467
1468instaweb.modulepath::
Junio C Hamano619596a2010-08-18 22:15:351469The default module path for linkgit:git-instaweb[1] to use
1470instead of /usr/lib/apache2/modules. Only used if httpd
1471is Apache.
Junio C Hamano4e272312008-01-08 09:13:211472
1473instaweb.port::
1474The port number to bind the gitweb httpd to. See
1475linkgit:git-instaweb[1].
1476
Junio C Hamanoe5bf6c12009-02-07 21:43:101477interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001478In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101479input with a single key (i.e., without hitting enter).
Junio C Hamanob76a6862012-05-02 22:02:461480Currently this is used by the `--patch` mode of
Junio C Hamano3d050d62011-05-17 06:43:341481linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1482linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1483setting is silently ignored if portable keystroke input
1484is not available.
Junio C Hamanoe5bf6c12009-02-07 21:43:101485
Junio C Hamanof93530e2011-05-25 23:59:591486log.abbrevCommit::
1487If true, makes linkgit:git-log[1], linkgit:git-show[1], and
Junio C Hamanob76a6862012-05-02 22:02:461488linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1489override this option with `--no-abbrev-commit`.
Junio C Hamanof93530e2011-05-25 23:59:591490
Junio C Hamanob713ff12008-05-24 01:12:301491log.date::
Junio C Hamano2db3e752010-09-03 21:33:061492Set the default date-time mode for the 'log' command.
1493Setting a value for log.date is similar to using 'git log''s
Junio C Hamanob76a6862012-05-02 22:02:461494`--date` option. Possible values are `relative`, `local`,
Junio C Hamano2db3e752010-09-03 21:33:061495`default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1496for details.
Junio C Hamanob713ff12008-05-24 01:12:301497
Junio C Hamanocb39aea2010-05-09 07:24:481498log.decorate::
1499Print out the ref names of any commits that are shown by the log
1500command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1501'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1502specified, the full ref name (including prefix) will be printed.
1503This is the same as the log commands '--decorate' option.
1504
Junio C Hamanofe9acab2006-11-24 12:10:551505log.showroot::
1506If true, the initial commit will be shown as a big creation event.
1507This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461508Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551509normally hide the root commit will now show it. True by default.
1510
Junio C Hamano8bc410e2009-02-15 10:38:191511mailmap.file::
1512The location of an augmenting mailmap file. The default
1513mailmap, located in the root of the repository, is loaded
1514first, then the mailmap file pointed to by this variable.
1515The location of the mailmap file may be in a repository
1516subdirectory, or somewhere outside of the repository itself.
1517See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1518
Junio C Hamano8b588d52008-03-15 09:48:371519man.viewer::
1520Specify the programs that may be used to display help in the
1521'man' format. See linkgit:git-help[1].
1522
Junio C Hamano6d76d612008-05-09 05:46:081523man.<tool>.cmd::
1524Specify the command to invoke the specified man viewer. The
1525specified command is evaluated in shell with the man page
1526passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261527
Junio C Hamano6d76d612008-05-09 05:46:081528man.<tool>.path::
1529Override the path for the given tool that may be used to
1530display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131531
Junio C Hamano4653c6f2008-11-26 22:50:201532include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421533
Junio C Hamano1fbbbc12007-12-18 07:01:271534mergetool.<tool>.path::
1535Override the path for the given tool. This is useful in case
1536your tool is not in the PATH.
1537
Junio C Hamano86bcccc2008-03-08 09:33:551538mergetool.<tool>.cmd::
1539Specify the command to invoke the specified merge tool. The
1540specified command is evaluated in shell with the following
1541variables available: 'BASE' is the name of a temporary file
1542containing the common base of the files to be merged, if available;
1543'LOCAL' is the name of a temporary file containing the contents of
1544the file on the current branch; 'REMOTE' is the name of a temporary
1545file containing the contents of the file from the branch being
1546merged; 'MERGED' contains the name of the file to which the merge
1547tool should write the results of a successful merge.
1548
1549mergetool.<tool>.trustExitCode::
1550For a custom merge command, specify whether the exit code of
1551the merge command can be used to determine whether the merge was
1552successful. If this is not set to true then the merge target file
1553timestamp is checked and the merge assumed to have been successful
1554if the file has been updated, otherwise the user is prompted to
1555indicate the success of the merge.
1556
1557mergetool.keepBackup::
1558After performing a merge, the original file with conflict markers
1559can be saved as a file with a `.orig` extension. If this variable
1560is set to `false` then this file is not preserved. Defaults to
1561`true` (i.e. keep the backup files).
1562
Junio C Hamano10b7a342009-01-01 22:05:171563mergetool.keepTemporaries::
1564When invoking a custom merge tool, git uses a set of temporary
1565files to pass to the tool. If the tool returns an error and this
1566variable is set to `true`, then these temporary files will be
1567preserved, otherwise they will be removed after the tool has
1568exited. Defaults to `false`.
1569
1570mergetool.prompt::
1571Prompt before each invocation of the merge resolution program.
1572
Junio C Hamano31667362010-03-25 00:38:531573notes.displayRef::
1574The (fully qualified) refname from which to show notes when
1575showing commit messages. The value of this variable can be set
1576to a glob, in which case notes from all matching refs will be
1577shown. You may also specify this configuration variable
1578several times. A warning will be issued for refs that do not
1579exist, but a glob that does not match any refs is silently
1580ignored.
1581+
1582This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1583environment variable, which must be a colon separated list of refs or
1584globs.
1585+
1586The effective value of "core.notesRef" (possibly overridden by
1587GIT_NOTES_REF) is also implicitly added to the list of refs to be
1588displayed.
1589
1590notes.rewrite.<command>::
1591When rewriting commits with <command> (currently `amend` or
1592`rebase`) and this variable is set to `true`, git
1593automatically copies your notes from the original to the
1594rewritten commit. Defaults to `true`, but see
1595"notes.rewriteRef" below.
Junio C Hamano31667362010-03-25 00:38:531596
1597notes.rewriteMode::
1598When copying notes during a rewrite (see the
1599"notes.rewrite.<command>" option), determines what to do if
1600the target commit already has a note. Must be one of
1601`overwrite`, `concatenate`, or `ignore`. Defaults to
1602`concatenate`.
1603+
1604This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1605environment variable.
1606
1607notes.rewriteRef::
1608When copying notes during a rewrite, specifies the (fully
1609qualified) ref whose notes should be copied. The ref may be a
1610glob, in which case notes in all matching refs will be copied.
1611You may also specify this configuration several times.
1612+
1613Does not have a default value; you must configure this variable to
Junio C Hamano8fb66e52011-10-05 20:59:511614enable note rewriting. Set it to `refs/notes/commits` to enable
1615rewriting for the default commit notes.
Junio C Hamano2b3ee5d2010-05-08 05:41:181616+
1617This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1618environment variable, which must be a colon separated list of refs or
1619globs.
Junio C Hamano31667362010-03-25 00:38:531620
Junio C Hamano75cc4c92006-07-24 08:25:031621pack.window::
Junio C Hamano35738e82008-01-07 07:55:461622The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031623window size is given on the command line. Defaults to 10.
1624
Junio C Hamano91d44c52007-05-09 07:16:071625pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461626The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071627maximum depth is given on the command line. Defaults to 50.
1628
Junio C Hamano235d53f2007-07-13 00:25:151629pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461630The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151631when no limit is given on the command line. The value can be
1632suffixed with "k", "m", or "g". Defaults to 0, meaning no
1633limit.
1634
Junio C Hamanof2ce2972007-05-20 19:12:091635pack.compression::
1636An integer -1..9, indicating the compression level for objects
1637in a pack file. -1 is the zlib default. 0 means no
1638compression, and 1..9 are various speed/size tradeoffs, 9 being
1639slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421640not set, defaults to -1, the zlib default, which is "a default
1641compromise between speed and compression (currently equivalent
1642to level 6)."
Junio C Hamano657fd8a2010-10-07 00:01:241643+
1644Note that changing the compression level will not automatically recompress
1645all existing objects. You can force recompression by passing the -F option
1646to linkgit:git-repack[1].
Junio C Hamanof2ce2972007-05-20 19:12:091647
Junio C Hamano679d22d2007-06-02 21:13:441648pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271649The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521650linkgit:git-pack-objects[1] before writing them out to a pack.
1651This cache is used to speed up the writing object phase by not
1652having to recompute the final delta result once the best match
1653for all objects is found. Repacking large repositories on machines
1654which are tight with memory might be badly impacted by this though,
1655especially if this cache pushes the system into swapping.
1656A value of 0 means no limit. The smallest size of 1 byte may be
1657used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441658
1659pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141660The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521661linkgit:git-pack-objects[1]. This cache is used to speed up the
1662writing object phase by not having to recompute the final delta
1663result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441664
Junio C Hamano58155b42007-09-15 07:46:141665pack.threads::
1666Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461667delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141668be compiled with pthreads otherwise this option is ignored with a
1669warning. This is meant to reduce packing time on multiprocessor
1670machines. The required amount of memory for the delta search window
1671is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441672Specifying 0 will cause git to auto-detect the number of CPU's
1673and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141674
Junio C Hamanod814b6d2007-11-04 11:13:491675pack.indexVersion::
1676Specify the default pack index version. Valid values are 1 for
1677legacy pack index used by Git versions prior to 1.5.2, and 2 for
1678the new pack index with capabilities for packs larger than 4 GB
1679as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381680packs. Version 2 is the default. Note that version 2 is enforced
1681and this config option ignored whenever the corresponding pack is
1682larger than 2 GB.
1683+
Junio C Hamanob76a6862012-05-02 22:02:461684If you have an old git that does not understand the version 2 `*.idx` file,
Junio C Hamanofce7c7e2008-07-02 03:06:381685cloning or fetching over a non native protocol (e.g. "http" and "rsync")
Junio C Hamanob76a6862012-05-02 22:02:461686that will copy both `*.pack` file and corresponding `*.idx` file from the
Junio C Hamanofce7c7e2008-07-02 03:06:381687other side may give you a repository that cannot be accessed with your
Junio C Hamanob76a6862012-05-02 22:02:461688older version of git. If the `*.pack` file is smaller than 2 GB, however,
Junio C Hamanofce7c7e2008-07-02 03:06:381689you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
Junio C Hamanob76a6862012-05-02 22:02:461690the `*.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491691
Junio C Hamano09a926d2008-03-13 07:55:291692pack.packSizeLimit::
Junio C Hamano4d979582010-02-04 06:27:291693The maximum size of a pack. This setting only affects
1694packing to a file when repacking, i.e. the git:// protocol
Junio C Hamanob76a6862012-05-02 22:02:461695is unaffected. It can be overridden by the `--max-pack-size`
Junio C Hamano4d979582010-02-04 06:27:291696option of linkgit:git-repack[1]. The minimum size allowed is
1697limited to 1 MiB. The default is unlimited.
1698Common unit suffixes of 'k', 'm', or 'g' are
1699supported.
Junio C Hamano49dccaf2008-02-10 10:48:011700
Junio C Hamano9e96a1a2008-08-16 10:23:181701pager.<cmd>::
Junio C Hamano788eeba2010-12-08 22:50:431702If the value is boolean, turns on or off pagination of the
1703output of a particular git subcommand when writing to a tty.
1704Otherwise, turns on pagination for the subcommand using the
Junio C Hamanob76a6862012-05-02 22:02:461705pager specified by the value of `pager.<cmd>`. If `--paginate`
1706or `--no-pager` is specified on the command line, it takes
Junio C Hamano788eeba2010-12-08 22:50:431707precedence over this option. To disable pagination for all
1708commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181709
Junio C Hamanoa574a092010-06-13 19:57:101710pretty.<name>::
1711Alias for a --pretty= format string, as specified in
1712linkgit:git-log[1]. Any aliases defined here can be used just
1713as the built-in pretty formats could. For example,
Junio C Hamanob76a6862012-05-02 22:02:461714running `git config pretty.changelog "format:* %H %s"`
Junio C Hamanoa574a092010-06-13 19:57:101715would cause the invocation `git log --pretty=changelog`
Junio C Hamanob76a6862012-05-02 22:02:461716to be equivalent to running `git log "--pretty=format:* %H %s"`.
Junio C Hamanoa574a092010-06-13 19:57:101717Note that an alias with the same name as a built-in format
1718will be silently ignored.
1719
Junio C Hamano515ab1d2011-12-09 23:41:201720pull.rebase::
1721When true, rebase branches on top of the fetched branch, instead
1722of merging the default branch from the default remote when "git
1723pull" is run. See "branch.<name>.rebase" for setting this on a
1724per-branch basis.
1725+
1726*NOTE*: this is a possibly dangerous operation; do *not* use
1727it unless you understand the implications (see linkgit:git-rebase[1]
1728for details).
1729
Junio C Hamano07824ce2006-04-25 07:36:541730pull.octopus::
1731The default merge strategy to use when pulling multiple branches
1732at once.
1733
1734pull.twohead::
1735The default merge strategy to use when pulling a single branch.
1736
Junio C Hamano1de75722009-03-26 08:39:381737push.default::
1738Defines the action git push should take if no refspec is given
1739on the command line, no refspec is configured in the remote, and
1740no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191741line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381742+
Junio C Hamanobcaa8bc2012-07-03 22:17:201743--
Junio C Hamano7f9fa862010-10-19 23:51:141744* `nothing` - do not push anything.
Junio C Hamanob76a6862012-05-02 22:02:461745* `matching` - push all branches having the same name in both ends.
1746 This is for those who prepare all the branches into a publishable
1747 shape and then push them out with a single command. It is not
1748 appropriate for pushing into a repository shared by multiple users,
1749 since locally stalled branches will attempt a non-fast forward push
1750 if other users updated the branch.
1751 +
1752 This is currently the default, but Git 2.0 will change the default
1753 to `simple`.
Junio C Hamano63c2bc92011-02-28 06:41:281754* `upstream` - push the current branch to its upstream branch.
Junio C Hamanob76a6862012-05-02 22:02:461755 With this, `git push` will update the same remote ref as the one which
1756 is merged by `git pull`, making `push` and `pull` symmetrical.
1757 See "branch.<name>.merge" for how to configure the upstream branch.
1758* `simple` - like `upstream`, but refuses to push if the upstream
1759 branch's name is different from the local one. This is the safest
1760 option and is well-suited for beginners. It will become the default
1761 in Git 2.0.
Junio C Hamano7f9fa862010-10-19 23:51:141762* `current` - push the current branch to a branch of the same name.
Junio C Hamanobcaa8bc2012-07-03 22:17:201763--
1764+
1765The `simple`, `current` and `upstream` modes are for those who want to
1766push out a single branch after finishing work, even when the other
1767branches are not yet ready to be pushed out. If you are working with
1768other people to push into the same shared repository, you would want
1769to use one of these.
Junio C Hamano1de75722009-03-26 08:39:381770
Junio C Hamanoea6a7642009-03-11 23:56:191771rebase.stat::
1772Whether to show a diffstat of what changed upstream since the last
1773rebase. False by default.
1774
Junio C Hamano075ae872010-09-01 18:43:071775rebase.autosquash::
1776If set to true enable '--autosquash' option by default.
1777
Junio C Hamano621e1232009-10-26 05:16:471778receive.autogc::
1779By default, git-receive-pack will run "git-gc --auto" after
1780receiving data from git-push and updating refs. You can stop
1781it by setting this variable to false.
1782
Junio C Hamano4653c6f2008-11-26 22:50:201783receive.fsckObjects::
1784If it is set to true, git-receive-pack will check all received
1785objects. It will abort in the case of a malformed object or a
1786broken link. The result of an abort are only dangling objects.
Junio C Hamano8fb66e52011-10-05 20:59:511787Defaults to false. If not set, the value of `transfer.fsckObjects`
1788is used instead.
Junio C Hamano4653c6f2008-11-26 22:50:201789
1790receive.unpackLimit::
1791If the number of objects received in a push is below this
1792limit then the objects will be unpacked into loose object
1793files. However if the number of received objects equals or
1794exceeds this limit then the received pack will be stored as
1795a pack, after adding any missing delta bases. Storing the
1796pack from a push can make the push operation complete faster,
1797especially on slow filesystems. If not set, the value of
1798`transfer.unpackLimit` is used instead.
1799
1800receive.denyDeletes::
1801If set to true, git-receive-pack will deny a ref update that deletes
1802the ref. Use this to prevent such a ref deletion via a push.
1803
Junio C Hamanob4448a82010-07-26 09:02:321804receive.denyDeleteCurrent::
1805If set to true, git-receive-pack will deny a ref update that
1806deletes the currently checked out branch of a non-bare repository.
1807
Junio C Hamano4653c6f2008-11-26 22:50:201808receive.denyCurrentBranch::
Junio C Hamanoe97d5772010-05-19 08:13:581809If set to true or "refuse", git-receive-pack will deny a ref update
Junio C Hamano4653c6f2008-11-26 22:50:201810to the currently checked out branch of a non-bare repository.
1811Such a push is potentially dangerous because it brings the HEAD
1812out of sync with the index and working tree. If set to "warn",
1813print a warning of such a push to stderr, but allow the push to
1814proceed. If set to false or "ignore", allow such pushes with no
Junio C Hamanoafb395b2010-03-17 22:16:151815message. Defaults to "refuse".
Junio C Hamano4653c6f2008-11-26 22:50:201816
1817receive.denyNonFastForwards::
1818If set to true, git-receive-pack will deny a ref update which is
Junio C Hamano3f680f32009-11-16 02:10:541819not a fast-forward. Use this to prevent such an update via a push,
Junio C Hamano4653c6f2008-11-26 22:50:201820even if that push is forced. This configuration variable is
1821set when initializing a shared repository.
1822
Junio C Hamano621e1232009-10-26 05:16:471823receive.updateserverinfo::
1824If set to true, git-receive-pack will run git-update-server-info
1825after receiving data from git-push and updating refs.
1826
Junio C Hamano249572f2006-10-24 05:44:081827remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461828The URL of a remote repository. See linkgit:git-fetch[1] or
1829linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081830
Junio C Hamano0e88f3e2009-06-21 08:03:251831remote.<name>.pushurl::
1832The push URL of a remote repository. See linkgit:git-push[1].
1833
Junio C Hamano58256872007-12-04 08:31:131834remote.<name>.proxy::
1835For remotes that require curl (http, https and ftp), the URL to
1836the proxy to use for that remote. Set to the empty string to
1837disable proxying for that remote.
1838
Junio C Hamano249572f2006-10-24 05:44:081839remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461840The default set of "refspec" for linkgit:git-fetch[1]. See
1841linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081842
1843remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461844The default set of "refspec" for linkgit:git-push[1]. See
1845linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081846
Junio C Hamano47d68a52008-05-06 06:35:401847remote.<name>.mirror::
1848If true, pushing to this remote will automatically behave
Junio C Hamanob76a6862012-05-02 22:02:461849as if the `--mirror` option was given on the command line.
Junio C Hamano47d68a52008-05-06 06:35:401850
Junio C Hamano118d2772007-02-21 20:24:101851remote.<name>.skipDefaultUpdate::
1852If true, this remote will be skipped by default when updating
Junio C Hamano9df0c662009-11-23 11:09:271853using linkgit:git-fetch[1] or the `update` subcommand of
1854linkgit:git-remote[1].
1855
1856remote.<name>.skipFetchAll::
1857If true, this remote will be skipped by default when updating
1858using linkgit:git-fetch[1] or the `update` subcommand of
1859linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101860
Junio C Hamano4ad294b2007-01-20 02:22:501861remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481862The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551863option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501864
Junio C Hamano54ea8d32007-01-25 07:59:481865remote.<name>.uploadpack::
1866The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551867option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481868
Junio C Hamano17dde0e2007-02-26 09:50:211869remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551870Setting this value to \--no-tags disables automatic tag following when
Junio C Hamanocc7636a2010-05-21 14:57:531871fetching from remote <name>. Setting it to \--tags will fetch every
1872tag from remote <name>, even if they are not reachable from remote
Junio C Hamano075ae872010-09-01 18:43:071873branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1874override this setting. See options \--tags and \--no-tags of
1875linkgit:git-fetch[1].
Junio C Hamano17dde0e2007-02-26 09:50:211876
Junio C Hamano096dde22009-12-26 23:14:111877remote.<name>.vcs::
1878Setting this to a value <vcs> will cause git to interact with
1879the remote with the git-remote-<vcs> helper.
1880
Junio C Hamano118d2772007-02-21 20:24:101881remotes.<group>::
1882The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461883<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101884
Junio C Hamano77b7e902006-10-23 07:18:501885repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381886By default, linkgit:git-repack[1] creates packs that use
1887delta-base offset. If you need to share your repository with
1888git older than version 1.4.4, either directly or via a dumb
1889protocol such as http, then you need to set this option to
1890"false" and repack. Access from old git versions over the
1891native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501892
Junio C Hamano4653c6f2008-11-26 22:50:201893rerere.autoupdate::
1894When set to true, `git-rerere` updates the index with the
1895resulting contents after it cleanly resolves conflicts using
1896previously recorded resolution. Defaults to false.
1897
1898rerere.enabled::
1899Activate recording of resolved conflicts, so that identical
Junio C Hamano4fd24422012-01-06 21:52:431900conflict hunks can be resolved automatically, should they be
1901encountered again. By default, linkgit:git-rerere[1] is
1902enabled if there is an `rr-cache` directory under the
Junio C Hamano864ba892012-01-13 17:42:051903`$GIT_DIR`, e.g. if "rerere" was previously used in the
1904repository.
Junio C Hamano4653c6f2008-11-26 22:50:201905
Junio C Hamano1bbd0f42009-07-23 06:20:291906sendemail.identity::
1907A configuration identity. When given, causes values in the
1908'sendemail.<identity>' subsection to take precedence over
1909values in the 'sendemail' section. The default identity is
1910the value of 'sendemail.identity'.
1911
1912sendemail.smtpencryption::
1913See linkgit:git-send-email[1] for description. Note that this
1914setting is not subject to the 'identity' mechanism.
1915
1916sendemail.smtpssl::
1917Deprecated alias for 'sendemail.smtpencryption = ssl'.
1918
1919sendemail.<identity>.*::
1920Identity-specific versions of the 'sendemail.*' parameters
1921found below, taking precedence over those when the this
1922identity is selected, through command-line or
1923'sendemail.identity'.
1924
1925sendemail.aliasesfile::
1926sendemail.aliasfiletype::
1927sendemail.bcc::
1928sendemail.cc::
1929sendemail.cccmd::
1930sendemail.chainreplyto::
1931sendemail.confirm::
1932sendemail.envelopesender::
1933sendemail.from::
1934sendemail.multiedit::
1935sendemail.signedoffbycc::
1936sendemail.smtppass::
1937sendemail.suppresscc::
1938sendemail.suppressfrom::
1939sendemail.to::
Junio C Hamanocb39aea2010-05-09 07:24:481940sendemail.smtpdomain::
Junio C Hamano1bbd0f42009-07-23 06:20:291941sendemail.smtpserver::
1942sendemail.smtpserverport::
Junio C Hamano39c7a692010-10-27 06:08:541943sendemail.smtpserveroption::
Junio C Hamano1bbd0f42009-07-23 06:20:291944sendemail.smtpuser::
1945sendemail.thread::
1946sendemail.validate::
1947See linkgit:git-send-email[1] for description.
1948
1949sendemail.signedoffcc::
1950Deprecated alias for 'sendemail.signedoffbycc'.
1951
Junio C Hamano07824ce2006-04-25 07:36:541952showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461953The default set of branches for linkgit:git-show-branch[1].
1954See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541955
Junio C Hamano942b35e2007-12-09 10:19:331956status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461957By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331958current directory. Setting this variable to `false` shows paths
1959relative to the repository root (this was the default for git
1960prior to v1.5.4).
1961
Junio C Hamano4224f992008-06-23 07:14:081962status.showUntrackedFiles::
1963By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1964files which are not currently tracked by Git. Directories which
1965contain only untracked files, are shown with the directory name
1966only. Showing untracked files means that Git needs to lstat() all
1967all the files in the whole repository, which might be slow on some
1968systems. So, this variable controls how the commands displays
1969the untracked files. Possible values are:
1970+
1971--
Junio C Hamano7f9fa862010-10-19 23:51:141972* `no` - Show no untracked files.
1973* `normal` - Show untracked files and directories.
1974* `all` - Show also individual files in untracked directories.
Junio C Hamano4224f992008-06-23 07:14:081975--
1976+
1977If this variable is not specified, it defaults to 'normal'.
1978This variable can be overridden with the -u|--untracked-files option
1979of linkgit:git-status[1] and linkgit:git-commit[1].
1980
Junio C Hamanob671fb52010-06-01 05:06:141981status.submodulesummary::
1982Defaults to false.
1983If this is set to a non zero number or true (identical to -1 or an
1984unlimited number), the submodule summary will be enabled and a
1985summary of commits for modified submodules will be shown (see
1986--summary-limit option of linkgit:git-submodule[1]).
1987
Junio C Hamano78e3a782010-07-15 22:24:451988submodule.<name>.path::
1989submodule.<name>.url::
1990submodule.<name>.update::
1991The path within this project, URL, and the updating strategy
1992for a submodule. These variables are initially populated
1993by 'git submodule init'; edit them to override the
1994URL and other values found in the `.gitmodules` file. See
1995linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1996
Junio C Hamano0d75e872010-12-17 06:57:261997submodule.<name>.fetchRecurseSubmodules::
Junio C Hamano5cd15182011-04-05 00:21:101998This option can be used to control recursive fetching of this
Junio C Hamano7165bf72011-01-04 22:06:181999submodule. It can be overridden by using the --[no-]recurse-submodules
Junio C Hamano0d75e872010-12-17 06:57:262000command line option to "git fetch" and "git pull".
2001This setting will override that from in the linkgit:gitmodules[5]
2002file.
2003
Junio C Hamano619596a2010-08-18 22:15:352004submodule.<name>.ignore::
2005Defines under what circumstances "git status" and the diff family show
2006a submodule as modified. When set to "all", it will never be considered
2007modified, "dirty" will ignore all changes to the submodules work tree and
2008takes only differences between the HEAD of the submodule and the commit
2009recorded in the superproject into account. "untracked" will additionally
2010let submodules with modified tracked files in their work tree show up.
2011Using "none" (the default when this option is not set) also shows
2012submodules that have untracked files in their work tree as changed.
2013This setting overrides any setting made in .gitmodules for this submodule,
Junio C Hamanode9745c2010-08-23 17:10:182014both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:352015"--ignore-submodules" option.
2016
Junio C Hamano75cc4c92006-07-24 08:25:032017tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:092018This variable can be used to restrict the permission bits of
2019tar archive entries. The default is 0002, which turns off the
2020world write bit. The special value "user" indicates that the
2021archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:462022linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:032023
Junio C Hamano8fb66e52011-10-05 20:59:512024transfer.fsckObjects::
2025When `fetch.fsckObjects` or `receive.fsckObjects` are
2026not set, the value of this variable is used instead.
2027Defaults to false.
2028
Junio C Hamano4653c6f2008-11-26 22:50:202029transfer.unpackLimit::
2030When `fetch.unpackLimit` or `receive.unpackLimit` are
2031not set, the value of this variable is used instead.
2032The default value is 100.
2033
Junio C Hamano24bc09a2008-02-28 00:27:442034url.<base>.insteadOf::
2035Any URL that starts with this value will be rewritten to
2036start, instead, with <base>. In cases where some site serves a
2037large number of repositories, and serves them with multiple
2038access methods, and some users need to use different access
2039methods, this feature allows people to specify any of the
2040equivalent URLs and have git automatically rewrite the URL to
2041the best alternative for the particular user, even for a
2042never-before-seen repository on the site. When more than one
2043insteadOf strings match a given URL, the longest match is used.
2044
Junio C Hamano7df6dcf2009-09-13 09:51:172045url.<base>.pushInsteadOf::
2046Any URL that starts with this value will not be pushed to;
2047instead, it will be rewritten to start with <base>, and the
2048resulting URL will be pushed to. In cases where some site serves
2049a large number of repositories, and serves them with multiple
2050access methods, some of which do not allow push, this feature
2051allows people to specify a pull-only URL and have git
2052automatically use an appropriate URL to push, even for a
2053never-before-seen repository on the site. When more than one
2054pushInsteadOf strings match a given URL, the longest match is
2055used. If a remote has an explicit pushurl, git will ignore this
2056setting for that remote.
2057
Junio C Hamano07824ce2006-04-25 07:36:542058user.email::
2059Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:342060Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:462061'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542062
2063user.name::
2064Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:482065Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:462066environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:542067
Junio C Hamanoa890c4f2007-01-28 10:29:212068user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:462069If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:212070automatically when creating a signed tag, you can override the
2071default selection with this variable. This option is passed
2072unchanged to gpg's --local-user parameter, so you may specify a key
2073using any method that gpg supports.
2074
Junio C Hamano4e272312008-01-08 09:13:212075web.browser::
2076Specify a web browser that may be used by some commands.
2077Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2078may use it.